GrIDsure endpoints
AllocateGrIDsure
AllocateGrIDsure(System.Collections.Generic.List{System.String},DataLayer.Entity.Transaction.BillingStyle,System.Boolean,System.Boolean,System.String)
Allocate GrIDsure tokens to a child account.
Parameters
Param: serials: List of serial numbers to allocate
Param: billingStyle: Billing style of the allocation: Allocation, Activation, Authentication or Transfer
Param: withCapacity: True to automatically add license capacity with the tokens
Param: isSale: True if this is a sale, false for rental.
Param: toOrganization: Account to allocate to
Returns:
- True if allocated successfully
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
AuthenticateGrIDsureToken
AuthenticateGrIDsureToken(System.String,System.String,System.String)
Authenticate a GrIDsure token
Parameters
Param: userName: User with the token
Param: response: Reponse
Param: organization: Account
Returns
- True if successful
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
</ br>
DeallocateGrIDsure
DeallocateGrIDsure(System.Collections.Generic.List{System.String},System.Boolean,System.String,System.String)
De-allocate GrIDsure tokens from a child account.
Parameters
Param: serials: List of serials to de-allocate from the child account
Param: isSale: True if tokens are being sold back up the chain.
Param: intoContainer: Container to place the tokens into
Param: fromOrganization: Account to move tokens from
Returns:
- True if tokens are de-allocated
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
GetGrIDsurechallenge
GetGrIDsurechallenge(System.String,System.String)
Get a challenge string for a GrIDsure token. This string must be processed into an image and presented to the user.
Parameters
Param: userName: User who is requesting the challenge
Param: organization: Account
Returns
- GrIDsure challenge string
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
ProvisionUsersGrIDsureTokens
ProvisionUsersGrIDsureTokens(System.Collections.Generic.List{System.String},System.String,System.String)
Provisions a list of users with GrIDsure tokens.
Parameters
Param: userNames: Names of the users to provision tokens to
Param: description: Provisioning task description
Param: organization: Account
Returns
A list in the same order as the user names provided:
FailedToAddToBatch | Failed to add user to provisioning task |
EmailSent | Success |
UserHasNoEmail | Can't provision to the user as they have no e-mail address |
FailedToSendEmail | Failed to send out the e-mail. Check e-mail settings for the account |
CouldntGetToken | Couldn't find an available SMS or MP token to use for SMS provisioning |
CouldntAssignToken | User could not be assigned an SMS token |
UserHasActiveToken | Cannot provision password as the user has an active token |
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
ResetGrIDsureTokenPIP
ResetGrIDsureTokenPIP(System.String,System.Byte\[\],System.String,System.String)
Reset the PIP for a GrIDsure token using an initialization key from getGrIDsureTokenInitKey and the correct response.
Parameters
Param: userName: User with the token
Param: initKey: Initialization key from getGrIDsureTokenInitKey
Param: response: Response to the initialization key
Param: organization: Account
Returns
- True if the PIP was reset
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
getGrIDsureToken
getGrIDsureToken(System.String,System.String)
Get the GrIDsure token for a given user.
Parameters
Param: userName: User name
Param: organization: Account
Returns
- The user's GrIDsure token (if they have one)
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
getGrIDsureTokenInitKey
getGrIDsureTokenInitKey(System.String,System.String)
Get the initialization Key for a GrIDsure token.
Parameters
Param: userName: User with a GrIDsure token
Param: organization: Account
Returns
- Initialization key
SOAP 1.1 sample
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
SOAP 1.2 sample
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP GET sample
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
Request:
Response:
HTTP POST sample
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
Request:
Response: